home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / button.n < prev    next >
Text File  |  1994-09-20  |  12KB  |  398 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/button.n,v 1.19 93/04/01 09:52:31 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS button tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. button \- Create and manipulate button widgets
  210. .SH SYNOPSIS
  211. \fBbutton\fI \fIpathName \fR?\fIoptions\fR?
  212. .SH "STANDARD OPTIONS"
  213. .LP
  214. .nf
  215. .ta 4c 8c 12c
  216. .VS
  217. \fBactiveBackground\fR    \fBbitmap\fR    \fBfont\fR    \fBrelief\fR
  218. \fBactiveForeground\fR    \fBborderWidth\fR    \fBforeground\fR    \fBtext\fR
  219. \fBanchor\fR    \fBcursor\fR    \fBpadX\fR    \fBtextVariable\fR
  220. \fBbackground\fR    \fBdisabledForeground\fR    \fBpadY\fR
  221. .VE
  222. .fi
  223. .LP
  224. See the ``options'' manual entry for details on the standard options.
  225. .SH "WIDGET-SPECIFIC OPTIONS"
  226. .ta 4c
  227. .LP
  228. .nf
  229. Name:    \fBcommand\fR
  230. Class:    \fBCommand\fR
  231. Command-Line Switch:    \fB\-command\fR
  232. .fi
  233. .IP
  234. Specifies a Tcl command to associate with the button.  This command
  235. is typically invoked when mouse button 1 is released over the button
  236. window.
  237. .LP
  238. .nf
  239. .VS
  240. Name:    \fBheight\fR
  241. Class:    \fBHeight\fR
  242. Command-Line Switch:    \fB\-height\fR
  243. .fi
  244. .IP
  245. Specifies a desired height for the button.
  246. If a bitmap is being displayed in the button then the value is in
  247. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  248. for text it is in lines of text.
  249. If this option isn't specified, the button's desired height is computed
  250. from the size of the bitmap or text being displayed in it.
  251. .LP
  252. .nf
  253. Name:    \fBstate\fR
  254. Class:    \fBState\fR
  255. Command-Line Switch:    \fB\-state\fR
  256. .fi
  257. .IP
  258. Specifies one of three states for the button:  \fBnormal\fR, \fBactive\fR,
  259. or \fBdisabled\fR.  In normal state the button is displayed using the
  260. \fBforeground\fR and \fBbackground\fR options.  The active state is
  261. typically used when the pointer is over the button.  In active state
  262. the button is displayed using the \fBactiveForeground\fR and
  263. \fBactiveBackground\fR options.  Disabled state means that the button
  264. is insensitive:  it doesn't activate and doesn't respond to mouse
  265. button presses.  In this state the \fBdisabledForeground\fR and
  266. \fBbackground\fR options determine how the button is displayed.
  267. .LP
  268. .nf
  269. Name:    \fBwidth\fR
  270. Class:    \fBWidth\fR
  271. Command-Line Switch:    \fB\-width\fR
  272. .fi
  273. .IP
  274. Specifies a desired width for the button.
  275. If a bitmap is being displayed in the button then the value is in
  276. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  277. for text it is in characters.
  278. If this option isn't specified, the button's desired width is computed
  279. from the size of the bitmap or text being displayed in it.
  280. .VE
  281. .BE
  282.  
  283. .SH DESCRIPTION
  284. .PP
  285. The \fBbutton\fR command creates a new window (given by the
  286. \fIpathName\fR argument) and makes it into a button widget.
  287. Additional
  288. options, described above, may be specified on the command line
  289. or in the option database
  290. to configure aspects of the button such as its colors, font,
  291. text, and initial relief.  The \fBbutton\fR command returns its
  292. \fIpathName\fR argument.  At the time this command is invoked,
  293. there must not exist a window named \fIpathName\fR, but
  294. \fIpathName\fR's parent must exist.
  295. .PP
  296. A button is a widget
  297. .VS
  298. that displays a textual string or bitmap.
  299. It can display itself in either of three different ways, according
  300. to
  301. the \fBstate\fR option; 
  302. .VE
  303. it can be made to appear raised, sunken, or flat;
  304. and it can be made to flash.  When a user invokes the
  305. button (by pressing mouse button 1 with the cursor over the
  306. button), then the Tcl command specified in the \fB\-command\fR
  307. option is invoked.
  308.  
  309. .SH "WIDGET COMMAND"
  310. .PP
  311. The \fBbutton\fR command creates a new Tcl command whose
  312. name is \fIpathName\fR.  This
  313. command may be used to invoke various
  314. operations on the widget.  It has the following general form:
  315. .DS C
  316. \fIpathName option \fR?\fIarg arg ...\fR?
  317. .DE
  318. \fIOption\fR and the \fIarg\fRs
  319. determine the exact behavior of the command.  The following
  320. commands are possible for button widgets:
  321. .TP
  322. \fIpathName \fBactivate\fR
  323. Change the button's state to \fBactive\fR and redisplay the button
  324. using its active foreground and background colors instead of normal
  325. colors.
  326. .VS
  327. This command is ignored if the button's state is \fBdisabled\fR.
  328. This command is obsolete and will eventually be removed;
  329. use ``\fIpathName \fBconfigure \-state active\fR'' instead.
  330. .VE
  331. .TP
  332. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  333. Query or modify the configuration options of the widget.
  334. If no \fIoption\fR is specified, returns a list describing all of
  335. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  336. information on the format of this list).  If \fIoption\fR is specified
  337. with no \fIvalue\fR, then the command returns a list describing the
  338. one named option (this list will be identical to the corresponding
  339. sublist of the value returned if no \fIoption\fR is specified).  If
  340. one or more \fIoption\-value\fR pairs are specified, then the command
  341. modifies the given widget option(s) to have the given value(s);  in
  342. this case the command returns an empty string.
  343. \fIOption\fR may have any of the values accepted by the \fBbutton\fR
  344. command.
  345. .TP
  346. \fIpathName \fBdeactivate\fR
  347. Change the button's state to \fBnormal\fR and redisplay the button
  348. using its normal foreground and background colors.
  349. .VS
  350. This command is ignored if the button's state is \fBdisabled\fR.
  351. This command is obsolete and will eventually be removed;
  352. use ``\fIpathName \fBconfigure \-state normal\fR'' instead.
  353. .VE
  354. .TP
  355. \fIpathName \fBflash\fR
  356. Flash the button.  This is accomplished by redisplaying the button
  357. several times, alternating between active and normal colors.  At
  358. the end of the flash the button is left in the same normal/active
  359. state as when the command was invoked.
  360. .VS
  361. This command is ignored if the button's state is \fBdisabled\fR.
  362. .VE
  363. .TP
  364. \fIpathName \fBinvoke\fR
  365. .VS
  366. Invoke the Tcl command associated with the button, if there is one.
  367. The return value is the return value from the Tcl command, or an
  368. empty string if there is no command associated with the button.
  369. This command is ignored if the button's state is \fBdisabled\fR.
  370. .VE
  371.  
  372. .SH "DEFAULT BINDINGS"
  373. .PP
  374. .VS
  375. Tk automatically creates class bindings for buttons that give them
  376. the following default behavior:
  377. .IP [1]
  378. The button activates whenever the mouse passes over it and deactivates
  379. whenever the mouse leaves the button.
  380. .IP [2]
  381. The button's relief is changed to sunken whenever mouse button 1 is
  382. pressed over the button, and the relief is restored to its original
  383. value when button 1 is later released.
  384. .IP [3]
  385. If mouse button 1 is pressed over the button and later released over
  386. the button, the button is invoked.  However, if the mouse is not
  387. over the button when button 1 is released, then no invocation occurs.
  388. .PP
  389. If the button's state is \fBdisabled\fR then none of the above
  390. actions occur:  the button is completely non-responsive.
  391. .PP
  392. The behavior of buttons can be changed by defining new bindings for
  393. individual widgets or by redefining the class bindings.
  394. .VE
  395.  
  396. .SH KEYWORDS
  397. button, widget
  398.